home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / lib / forms / lib.man < prev    next >
Text File  |  1992-03-02  |  2KB  |  48 lines
  1. '\" Copyright 1992 Regents of the University of California
  2. '\" Permission to use, copy, modify, and distribute this
  3. '\" documentation for any purpose and without fee is hereby
  4. '\" granted, provided that this notice appears in all copies.
  5. '\" The University of California makes no representations about
  6. '\" the suitability of this material for any purpose.  It is
  7. '\" provided "as is" without express or implied warranty.
  8. '\" 
  9. '\" $Header: /sprite/lib/forms/RCS/lib.man,v 1.4 92/03/02 15:25:36 bmiller Exp $ SPRITE (Berkeley)
  10. '/" 
  11. .so \*(]ltmac.sprite
  12. .HS libName lib
  13. .BS
  14. '\" Note:  do not modify the .SH NAME line immediately below!
  15. .SH NAME
  16. Proc1, Proc2, Proc3 \- Summary of what procedure(s) do(es).
  17. .SH SYNOPSIS
  18. .nf
  19. \fB#include <module.h>\fR
  20. .sp
  21. ReturnType *
  22. \fBProc1\fR(\fIname\fP)
  23. .sp
  24. void
  25. \fBProc2\fR(\fIargc\fR, \fIargv\fR)
  26. .SH ARGUMENTS
  27. .AS biggestType biggestName
  28. .AP char *name in
  29. Terse description of what \fIname\fR is.
  30. .AP int argc in
  31. Number of elements in \fIargv\fR.
  32. .AP char **argv in/out
  33. Description of the \fIargv\fR argument.  ``In/Out'' means that \fI*argv\fR
  34. may be modified by the procedure.
  35. .BE
  36.  
  37. .SH DESCRIPTION
  38. .PP
  39. In this section you describe how to use the procedures.  The description
  40. should be relatively complete, but terse.  For complex libraries,
  41. use multiple sections, each describing some aspect of the library.
  42. See \fIThe Sprite Engineering Manual\fR for general information on writing
  43. manual pages, and the \fBman\fR manual entry in the \fBfiles\fR manual section
  44. for details on all the macros that are available.
  45.  
  46. .SH KEYWORDS
  47. form, manual
  48.